cs-utilities-system-api-services

This dictionary provides key definitions and descriptions of the main terms, endpoints, and parameters used in the System Utilities API.

🔑 Core Concepts

• API (Application Programming Interface): A set of rules that allow different applications to communicate with each other.
• Endpoint: A specific URL where resources or services of the API can be accessed.
• Base URL: The main address used as the starting point for all API requests.
• Bearer Token: An access token used for secure authentication via the OAuth 2.0 protocol.
• Client ID: A unique identifier assigned to an application using the API.

🌐 Base Information

• API Title: System Utilities API
• Version: 1.0.0
• Base URL: https://<your-domain>/v1/

🚀 Endpoints Dictionary

1️⃣ /Utilities/v1/basicTables/{action}

• Method: GET
• Description: Retrieves data from basic system tables based on the specified action.
• Parameters: action (number) - Defines the type of basic table operation.
• Response: List of basic table data.

2️⃣ /Utilities/v1/messaging/sendEmail

• Method: POST
• Description: Sends an email with the specified subject, content, and recipient.
• Request Body: subject (string), content (string), to (string)
• Response: Confirmation that the email was successfully sent.

3️⃣ /security/otpcode

• Method: GET
• Description: Generates a One-Time Password (OTP) for secure user verification.
• Query Parameters: to (string), expiry (integer)
• Response: OTP code with expiration details.

4️⃣ /security/otpcode/validate

• Method: POST
• Description: Validates a provided OTP code.
• Request Body: otpCode (string), userId (string)
• Response: Confirmation of OTP validity.

5️⃣ /notification/email/smtp

• Method: GET
• Description: Retrieves SMTP configuration details for email servers.
• Response: SMTP server configuration information.

6️⃣ /insurance/policies

• Method: POST
• Description: Submits insurance policy transactions.
• Request Body: policyData (object)
• Response: Confirmation of policy submission.

7️⃣ /insurance/lifeRates

• Method: GET
• Description: Retrieves life insurance rate frequencies by sales channel and product code.
• Query Parameters: channel (string), productCode (string)
• Response: List of rate frequencies.

8️⃣ /insurance/homeCoverage

• Method: GET
• Description: Retrieves home insurance coverage options based on product.
• Query Parameters: productCode (string)
• Response: List of coverage combinations.

9️⃣ /insurance/products

• Method: GET
• Description: Retrieves available insurance products based on the sales channel.
• Query Parameters: channel (string)
• Response: List of insurance products.

🔟 /files/shares

• Method: POST
• Description: Securely uploads files to the system.
• Request Body: Binary file data (application/octet-stream).
• Response: Confirmation of file upload with metadata.

1️⃣1️⃣ /claims

• Method: GET
• Description: Retrieves policies linked to a specific claim ID.
• Query Parameters: claimId (string), system (string)
• Response: List of associated policies.

1️⃣2️⃣ /web-api/report-use/register-data

• Method: POST
• Description: Registers usage data for knowledge management purposes.
• Request Body: usageData (object)
• Response: Confirmation of data registration.

🗂️ Common Parameters

⚠️ Error Codes

🗒️ Notes

• Always use HTTPS to ensure secure communication.
• Include the client_id and Authorization headers for all protected endpoints.

Last updated: February 2025 epalma@fgs.co